Magnum One

home *** CD-ROM | disk | FTP | other *** search

/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d8 / suprk445.arc / SUPERK.DOC < prev

Wrap

Text File | 1990-08-16 | 55KB | 1,128 lines

SuperK v4.45 MiniNet's External Protocol Driver including JBatch MiniNet's Driver for Richard B. Johnson's Jmodem Protocol Protocols Supported: Xmodem Checksum Xmodem CRC Ymodem (1k Xmodem) Jmodem Cmodem WXmodem K9Xmodem Super8K Super8K-G MNP Full Batch or Single File Mode No, Auto or Prompt Resume. SuperK is Copyright 12/4/1986, 1989 and JBatch is Copyright 11/01/1988, 1989 by Crater Rim Software. All Rights Reserved. = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = SuperK Licensing Agreement -------------------------- For the sake of clarity, all references and restrictions to the use of the SuperK also apply to all of the associated support files INCLUDING the K9Xmodem, Super8K and Jbatch protocols. SuperK, its overlays and all of its associated support files are not public domain software, nor are they free software. SuperK is copyright (c) 1985, 1989 - the K9Xmodem, Super8K, SuperK and JBatch protocols are copyright (c) 1987, 1989 by Crater Rim Software with All Rights Reserved by Crater Rim Software. Non-registered users are granted a limited license to use SuperK version 4.xx on a trial basis for the purpose of determining whether these programs are suitable for their needs. The term of this limited license is 30 days. Use of SuperK, except for this limited purpose, requires registration. Use of non-registered copies of SuperK by any person, business, corporation, governmental agency or other entity is strictly forbidden. Registration permits you to use SuperK on a regular basis on a single computer. A registered user may use the program on a different computer, but may not use the program on more than one computer at the same time. MULTIPLE NODE BBSES WHICH OPERATE IN A NETWORKING ENVIRONMENT BUT ARE USING ONE COPY OF SUPERK ARE CONSIDERED TO BE USING MULTIPLE COPIES AND REQUIRE A REGISTRATION FOR EACH BBS NODE. Registration also includes priority support on Underdog's MiniNet BBS. Users need register only one version of SuperK. Registration includes licensed use of all upgrades. All corporate, business, government or other commercial uses of SuperK must be registered. We offer quantity discounts and Corporate or site licensing is also available. No user may modify SuperK in any way, including but not limited to decompiling, disassembling or otherwise reverse engineering the program. All users are granted a limited license to copy SuperK version 4.xx only for the trial use of others subject to the above limitations, and also the following: SuperK version 4.xx must be copied in unmodified form, complete with the file containing this license information. Any and all SuperK documentation must be included with the copy. No fee, charge or other compensation may be accepted or requested by any licensee. SuperK may not be distributed in conjunction with any other product without prior arrangements with Crater Rim Software. Operators of electronic bulletin board systems (Sysops) may post SuperK version 4.xx for downloading by their users only as long as the above conditions are met. Distributors of public domain or user supported software may distribute copies of SuperK version 4.xx subject to the above conditions only after obtaining written permission from Crater Rim Software. Please write or call for details. ShareWare Software Discalaimer and Warranty Crater Rim Software makes no warranty of any kind, express or implied, including without limitation, any warranties of merchantability and/or fitness for a particular purpose. Crater Rim Software shall not be liable for any damages, whether direct, indirect, special or consequential arising from a failure of this program to operate in the manner desired by the user. Crater Rim Software shall not be liable for any damage to data or property which may be caused directly or indirectly by use of the program. IN NO EVENT WILL Crater Rim Software BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING ANY LOST PROFITS, LOST SAVINGS OR OTHER INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF YOUR USE OR INABILITY TO USE THE PROGRAM, OR FOR ANY CLAIM BY ANY OTHER PARTY. See the Ordering section for more information on registration, corporate licensing and similar topics. WARNING: YOU MAY NOT USE ANY VERSION OF SuperK ON A REGULAR BASIS WITHOUT REGISTERING THE PACKAGE. = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = SuperK External Protocol Driver - Revision Log V2.50 - Dated 08/22/88 Initial Release V2.52 - Dated 09/01/88 V3.10 - Dated 11/05/88 V3.12 - Dated 12/04/88 V3.13 - Dated 12/06/88 V3.14 - Dated 12/27/88 V3.15 - Dated 01/07/89 V3.16 - Dated 01/26/89 V4.00 - Dated 02/20/89 V4.10 - Dated 03/29/89 Changes Modem Buffer size has been increased from 4K to 8K It has been brought to my attention that the latest MS Basic compilers drop the RTS line when performing a DOS shell. SuperK now checks the RTS line upon startup and will raise it if it has been dropped. The addition of a Work Path so that SuperK can easily access Read Only files in a networking envirnment (see W - Work Path below). Corrected a bug in the Overwrite check. Under certain circumstances, an I/O error would occur if too many files were rejected by the receiver. V4.11 - Dated 04/05/89 Corrected a minor bug in the ReadOnly copy routine V4.12 - Dated 05/04/89 Changes In an effort to make Super8K a little more "bullet proof", I reworked then Super8K Error Recovery routines. There have been a number of users having problems with SuperK reporting a run time error of F0=xxxx. This is due to the fact that SuperK cannot find its overlay file, SUPERK.000. Seems there are some (antiquated) BBS packages that change directories before transferring a file! When this happens, SuperK is unable to find its overalay (or the SKA.COM jmodem module for that matter). If this is happening to you, be sure to start up SuperK as SUPERK @ and define OVL Path parameter to the FULL drive:\path\ where SUPERK resides. There are also reports that some BBS software is unable to "read" the SuperK errorlevel returned upon exit. This is a problem with the calling program NOT with SuperK as the errorlevel returned is fully recognized by DOS via a batch file. V4.20 - Dated 06/25/89 Changes - see documentation below Added support for Com ports 3 and 4. Added support for 38400, 57600 and 115200 bps. Added L command line parameter to let SuperK know that the port is locked Added C command line parameter to enable CTS checking for locked ports Added U command line parameter to allow the passage of actual modem speed when port is locked Added Quick Escape from the SuperK help screen(s). Simply press the [Esc] key and you will be returned to DOS with an errorlevel of 1. V4.30 - Dated 06/28/89 Changes - see documentation below Added a new protocol! MNP Super8K-G in single or batch mode! V4.31 - Dated 07/04/89 Changes Changed the way in which the transfer times are calculated... This has no effect on the cps calculations, just the estimated transfer time. Changed the Main transfer log file format to conform with the DSZ log file in that, if the transfer fails, the first character of the log file line will be an E rather than an R or S. V4.40 - Dated 07/28/89 Changes - There have been some reports of the Super8K protocols hanging when the locked port parameter is used. Although I have not been able to duplicate the problem, I have modified the CTS checking and doubled the timeout limit in the hopes that this will solve the problem. I've also added a short delay before returning to the batch mode receive Sync window so that the sender has enough time to clear its buffer. - The Jmodem driver, SKA.COM has been upgraded to the equivilant of Jmodem v1.20. This should clear up the intermittant transfer result reporting of the earlier SKA.COM version. On the same note, the Jmodem transfer status window has been modified so the it resembles the other SuperK protocols. - This version implements a Resume mode for K9Xmodem, Super8K-G and Super8K and ALL batch mode transfers except for Jmodem Batch! The Resume mode is set via the SuperK @ configuration and supports an inactive and 2 active states. Here's how it works... Within the SUPERK @ configuration section, the J option will cycle through the 3 states of Resume mode: No = normal operation with overwrite flag in control of how duplicate filenames are handled. Command Line Equals R0 Auto = automatic resume if and only if the receiver's file is smaller than the sender's file AND the receiver's file size is some multiple of 8K (SuperK default block write size). Command Line Equals R1 Prompt = if duplicate file is found, SuperK will prompt for resume instructions. Command Line Equals R2 Your options are: Resume Y Pressing Y (or any other key) commences the resumption of the transfer, appending the new data to the end of the receiver's file. Resume N Pressing N cancels the receipt of the file and moves on to the next file if using any batch protocol - or to DOS if using Super8K/Super8K-G single file mode (Other Single file protocols do not support Resume). Start Over Pressing S will inform SuperK that you wish to start this transfer anew. SuperK will erase the receiver's existant file and request that the sender start from the beginning of the file. Please note that the Prompt mode is on a timer loop that will timeout in about 15 seconds. If no user input is received before timing out, SuperK will default to whatever the default Overwrite flag is set to... Overwrite set to Yes = start transfer from from 0 bytes Overwrite set to No = cancel the transfer The command line will also accept an R# where # = 0, 1 or 2 (see definitions above) as part of the protocol prompt. If the optional R# parameter is specified, SuperK will force the preconfigured Resume mode to whatever state you specify for that transfer set (batch or single) only. Example: You have the resume flag set to No via SUPERK @ and want to perform a Super8K batch receive. The normal direction protocol parameter would be RSB however, you want SuperK to Prompt Resume on this transfer. The Prompt Resume Mode may be activated by making your direction protocol command line parameter read RSBR2 Since all of the SuperK protocols have a default 8K block write and each 8K block has been CRC accepted before being written to disk, there isn't any CRC check made on ANY resumed transfer. Again, NO CRC CHECKS ARE MADE ON THE EXISTANT PORTION OF A RESUMED FILE. On the same token, files that are less than 8K in size are automatically resent in their entirety and an active resume mode overrides the Overwrite flag setting. In summary... with the Resume mode active, the receiving side waits for the filesize from then sending side and then checks for an already existant file. If a file exists and the size is less than the filesize sent by the sender and the existant file is an exact multiple of 8K, SuperK will resume the transfer. If the size of the existant file is equal to or greater than the filesize sent by the sender, the receiver will refuse the file and move on to the next file (if in batch mode). And lastly... until this new version gets circulated around, be aware that if you are "talking" to a previous version of SuperK the resume feature will automatically abort the transfer. If this happens, drop to DOS and reconfigure SuperK with the Resume Mode set to No (or call SuperK with a direction protocol parameter that includes R0). - Added seperate WXmodem Transfer window color. The color difference makes it easier to distiguish between Xmodem and WXmodem transfers. - Due to the sluggish response of users to register the program, I've had to add a sharware screen with 10 second delay to act as an incentive to register... and since this version represents a MAJOR revision (requiring MAJOR rework and time), the registration fee has been raised to $25.00. I WILL CONTINUE TO ACCEPT $20.00 REGISTRATIONS FOR THIS VERSION OR ANY EARLIER VERSION UNTIL SEPTEMBER 10, 1989 AT WHICH TIME REGISTRATION WILL GO TO THE NEW $25.00 FEE. Users who have already registered earlier versions are NOT subject to the registration fee change and may download their registered versions directly from Underdog's MiniNet at (206) 725-9233 1200/2400/9600 HST. Registration gets you the latest version WITHOUT the Shareware screen and delay, the latest registered version on disk or via download from MiniNet, 1 year SuperK support and access to all future updates (both registered and non-registered) via MiniNet! V4.45 - Dated 10/22/89 Changes SuperK now supports Cmodem in single or batch mode! This brings the protocol count to 18 in all!!! Please note that the current version of Cmodem does not support locked ports and/or subdirectories. I can't do anything about the locked ports but have made facility in SuperK to change drives and/or directories when performing Cmodem transfers. The command line protocol designator for Cmodem transfers is H in the form (RH, SH, RHB or SHB). Since Cmodem has its own resume features, I have linked the SuperK resume mode to Cmodem - that is, a SuperK resume mode of No disables Cmodem resume - any other SuperK resume mode enables Cmodem resume. This version also eliminates the need for the use of COMMAND.COM when it performs its shell to the external Cmodem and Jmodem modules. This, along with some code modification should reduce SuperK memory requirements considerably! The Jmodem module (old SKA.COM) has been modified and renamed to SKJ.COM and, since COMMAND.COM is no longer used to perform internal DOS shells, SuperK has been "educated" to read the DOS error levels returned by SKJ and Cmodem, thus eliminating the need for multiple copies of the Jmodem module when using SuperK in a multinode BBS environment. Memory requirements: ~~~~~~~~~~~~~~~~~~~ Jmodem and Cmodem transfers require a minimum of 128K (128,000 bytes). All of the other protocols only require about 70K (71,680 bytes). If you don't know how much memory you have available, it can be checked easily as follows: 1) Copy DOS' CHKDSK.COM to your comm directory. 2) Start up your comm program and execute the comm program's DOS shell option. 3) Type CHKDSK at the DOS prompt 4) CHKDSK will display its results along with the "bytes free" figure. In order to perform Jmodem transfers, the "bytes free" must be at least 128,000 (if you intend on using SuperK's Jmodem). 5) Enter "EXIT" at the DOS prompt. 6) Exit your comm program... Command Line Syntax: ~~~~~~~~~~~~~~~~~~~ SuperK Px Sbaud [Ubaud] [Nx] [C] [L] [M] [R] [E] Dprotocol{by} F fspec fspec Command line parameters : ~~~~~~~~~~~~~~~~~~~~~~~ Px - Comm Port to use. Where x = 1, 2, 3 or 4 The port addresses and IRQ's are standard IBM/MSDOS values: Address IRQ ------- --- Com 1 = 03F8 hex 4 Com 2 = 02F8 hex 3 Com 3 = 03E8 hex 4 Com 4 = 02E8 hex 3 Please note: Com3 and Com4 may not work on your system. Be sure to check your Async Card manual to be sure that your port addresses and IRQ's are the same... Sbaud - Port Speed. Where baud = 300, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200 S300 = 300 bps S1200 = 1200 bps S2400 = 2400 bps S4800 = 4800 bps S9600 = 9600 bps S19200 = 19200 bps S38400 = 38400 bps S57600 = 57600 bps S115200 = 115200 bps This is the speed at which the comm port is set at and not necessarily the speed of the modem (if the port is locked that is). Please note: The 57600bps and 115200bps speeds, although feasible, require a high speed Async Card with an NS16550 UART and have not been tested (mine is one of those non-workable systems)... Ubaud - Modem Speed. Where baud = 300, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200 This is the actual speed (according to the connection) of the modem. The inclusion of the U parameter is purely optional and if present, will be used to accurately calculate the transfer times and accurately report the correct baud rate in the Transfer Log file. If it is not specified, SuperK will set its value equal to the actual port speed as specified via the S parameter. DirectionProtocol[b][y][r#] Direction of transfer. Where D = R (receive) or S (send) and Protocol X = Xmodem C = CRC Xmodem Y = Ymodem (1k Xmodem) W = WXmodem J = Jmodem H = Cmodem K = K9Xmodem S = Super8K M = MNP Super8K-G b = Perform the transfer in Batch mode. Note that both computers MUST be using SuperK or K9X in order for the Batch mode to be operational. y = SuperK allows you to specify if you want overwriting of existing files to be performed. By including a Y with the Direction/Protocol parameter, the default overwrite setting will be reversed during the current transfer. In single file mode, the J, X, C, W and Y protocols are fully compatible with their counterparts used on all/most BBS Both systems must be using SuperK to invoke the K9Xmodem or Super8K Protocols. Both y and b are optional. The y overwrite reversal only works in Batch mode (when the b is also present). If the b is omitted, SuperK defaults to single file mode MNP Super8K-G ~~~~~~~~~~~~~ A brand new protocol!!! As is the case with the other SuperK protocols, the new MNP Super8K-G protocol itself may be executed in either Batch (MB parameter) or Single File (M parameter) mode. This new protocol takes advantage of the MNP error correction of the new high speed (and some lower speed) modems. When called, the MNP Super8K-G automatically sets the Check-CTS flag and uses the built-in Flow Control code. Also, the Port Locked parameter L is not required. Along with a much improved throughput, the MNP Super8K-G protocol also rounds file sizes up to the next higher 128 byte sector, ala X/WXmodem, rather than the next higher 1K byte sector, ala Y/K9Xmodem. MNP Super8K-G uses an 8K block and since it IS NOT a windowing protocol (like WXmodem and K9Xmodem), the error/abort response time is improved 1000 fold! MNP Super8K-G also passes the number of file sectors to the receiving system so a file size and transfer time (approxomate) is displayed on both the sending and receiving systems. Of course, the MNP Super8K-G protocol has its own colors so be sure to setup SuperK before you use it! Since MNP Super8K-G only does a byte count update each 8K, the tranfer may seem to be taking a long time... but in reality.... the following SUPERK.LOG extract displays the preliminary test results for each of the SuperK protocols. These tests were run between two AT's via Null Modem cable. Results via modem will probably be a little lower accross the board. Size Speed Cps Errors BlkSize Protocol ------------------------------------------------------------- 140414 19200 bps 1526 cps 8 errors 1024 Zmodem Batch 140416 19200 bps 1902 cps 0 errors 8192 MNP Super8K-G 147930 19200 bps 1020 cps 48 errors 1024 Zmodem Batch 147968 19200 bps 1903 cps 0 errors 8192 MNP Super8K-G Super8K ~~~~~~~ A brand new protocol!!! As is the case with the other SuperK protocols, the Super8K protocol itself may be executed in either Batch (SB parameter) or Single File (S parameter) mode. Along with a much improved throughput, the Super8K protocol also rounds file sizes up to the next higher 128 byte sector, ala X/WXmodem, rather than the next higher 1K byte sector, ala Y/K9Xmodem. Super8K uses an 8K block with a 1K error fallback/restart and since it IS NOT a windowing protocol (like WXmodem and K9Xmodem), the error/abort response time is improved 1000 fold! Super8K also passes the number of file sectors to the receiving system so a file size and transfer time (approxomate) is displayed on both the sending and receiving systems. Of course, the Super8K protocol has its own colors so be sure to setup SuperK before you use it. Since Super8K only does a byte count update each 8K, the tranfer may seem to be taking a long time... but in reality.... the following SUPERK.LOG extract displays the preliminary test results for each of the SuperK protocols and a test comparison to Zmodem and Jmodem. These tests were run between two AT's via Null Modem cable. Results via modem will probably be a little lower accross the board. Size Speed Cps Errors BlkSize Protocol -------------------------------------------------------------- 60800 9600 bps 533 cps 0 errors 0 128 Xmodem Batch 60800 9600 bps 769 cps 0 errors 0 128 WXmodem Batch 61440 9600 bps 787 cps 0 errors 0 1024 Ymodem Batch 61440 9600 bps 869 cps 0 errors 0 1024 K9Xmodem Batch 60707 9600 bps 861 cps 0 errors 0 1024 Zmodem 60800 9600 bps 965 cps 0 errors 0 8192 Super8K Batch 60707 2400 bps 223 cps 0 errors 0 1024 Jmodem 60707 2400 bps 222 cps 0 errors 0 1024 Zmodem 60800 2400 bps 262 cps 0 errors 0 8192 Super8K Batch --------------------------------------------------------------- C - Perform CTS checking. This parameter is for those of you who have your comm ports locked at a higher baud rate than the actual connection. If this is the case, be sure to include this paramater. The default is for no CTS monitoring. Here's the result of the ATI5 USR Modem Command" USRobotics Courier 9600 HST NRAM Settings.... DIAL=HUNT M=0 X=6 F=1 B=0 BAUD=19200 PARITY=N WORDLEN=8 &A1 &B1 &G0 &H3 &I0 &K0 &M4 &N0 &P0 &R2 &S1 &Y1 S02=043 S03=013 S04=010 S05=008 S06=002 S07=030 S08=002 S09=006 S10=007 S11=070 S12=050 S13=000 S15=000 S19=000 S21=010 S22=017 S23=019 L - Port Locked flag. In order for the Super8K protocol to work in locked port setups, SuperK must disable its normal Xon/Xoff checking in order to recognize the Xon/Xoff sent by the modem when it has its port locked. This command line parameter is provided to let SuperK know that the port is locked and MUST be present when using an USR HST with the port locked. The default is port is not locked. M - Monitor Carrier, abort if not present. Including this parameter allows you to use SuperK to transfer files between systems via null modem cable. Default is ON (Monitor Carrier). Nx - Node Letter or Number. Where x = A to Z or 0 to 9 E - The E parameter toggles the status of the "erase" flag. If specified on the command line, SuperK will not erase the BATCHLST file it creates when multiple filenames are specified on the command line (until the next time you specify multiple filenames, that is!) R - This Command Line Parameter is for use with RBBS-PC. RBBS-PC utilizes a true Batch download with a single file mode upload. During uploads, RBBS-PC includes the full path and filename for the f paramter. Since SuperK Batch modes are TRUE Batch in both downloads and uploads, I have added the R command line switch to tell SuperK that the F parameter may (or may not) include a filename. When SuperK sees the R parameter, it will look for the last \ or : characters and parse all characters after that, thus leaving just the path... which it then appends to any uploads. The default is True (non RBBS-PC) batch uploads. RBBS command line for Batch Receive using K9Xmodem Batch SUPERK.COM p[PORT#] s[BAUD] r n[NODE] rkb f [FILE] RBBS command line for Batch Receive using K9Xmodem Batch SUPERK.COM p[PORT#] s[BAUD] r n[NODE] skb f [FILE] example: RBBS-PC passes [FILE] as C:\RBBS\99\filename.ext (or your defined upload path) during uploads exclusion of the R command line parameter results in an invalid file specification of C:\RBBS\99\filename.ext\ inclusion of the R command line parameter results in a valid file specification of C:\RBBS\99\ for obvious reasons, if you use the R command line parameter, you must include the last \ or at least one superflous (non \ or : character) at the end of the F specification. when using the R parameter... valid C:\RBBS\99\*.* results in C:\RBBS\99\ valid C:\RBBS\99\ABC.PAK results in C:\RBBS\99\ valid C:\RBBS\99\ results in C:\RBBS\99\ invalid C:\RBBS\99 results in C:\RBBS\ no f parameter results in *.* (all files saved in logged drive\dir) when using the default (non RBBS-PC) invalid C:\RBBS\99\*.* results in C:\RBBS\99\*.*\ invalid C:\RBBS\99\ABC.PAK results in C:\RBBS\99\ABC.PAK\ valid C:\RBBS\99\ results in C:\RBBS\99\ valid C:\RBBS\99 results in C:\RBBS\99\ no f parameter results in *.* (all files saved in logged drive\dir) F - Filespecs Next This parameter acts as a flag for SuperK and denotes that ALL parameters after the F are to be interpreted as filenames. For obvious reasons, this parameter should be the last one specified (before the filenames)! Each filename may contain a full path in the form: [d:\path\]Filename [d:\path\]Filename to send/receive. or You may also specify the use of a text file containing a list of filenames. Each filename in the list may contain a full path. This option is specified as: @drive:\path\Filelist (of files to Batch send. or You may want to use the second option for file lists... that is, include a second path where ALL of the files within the list reside. This option is specified as: @drive:\path\listfilename@drive:\path @ - Default Configuration Mode Modify colors/logfile name/xferfile name/overlay path/options flags Clone SUPERK.COM if changes are made The port, speed and direction/protocol parameters MUST be supplied... If operating in single file mode, the F parameter must be supplied. The B, E, U, L, C, Y, M, N and R parameters are optional... and the @ parameter is only used to review/modify the default settings (see modification mode below). The direction R and S parameters are mutually exclusive (only one, but not both). Command Line parameters may be supplied as upper or lower case, and may be entered in any order (except for the F paramter which must be the last one... before any filenames). SK4.LOG ~~~~~~~ SuperK will record transfer results to the logfile in the following format: +--- Transfer Direction or E for aborted transfer | +------- File Size (0 if transfer fails) | | +---------- Modem Speed | | | +---------- CPS efficiency (0 if transfer fails) | | | | +------------- Number of errors | | | | | +-- Dummy for DSZLOG compatability | | | | | | +----- Packet size in bytes | | | | | | | +--- Filename | | | | | | | | Protocol ----++- Batch | | | | | | | | || S 27648 1200 bps 108 cps 0 errors 0 1024 C:\DLS\SUPERK.PAK KB XFER.TXT ~~~~~~~~ If (and only if) a Node character is specified OR a question mark is used within the XferFile name or SuperK Log file name, SuperK will also create a Xfer Node File to show success/failure status messages. This file has the following format : Filename Upload or Download Protocol (J/X/C/Y/W/H/K/S/M/JB/XB/CB/YB/WB/HB/KB/SB/MB) Success or Fail EOF (^Z) Sample: SUPERK.PAK Download KB Success ^Z The file will be created in the default directory if no drive/path is specified during the command line @ parameter modification mode. While in batch mode, only the first file transfer results will be logged to this file. However, SK4.LOG will contain the results of all files transferred in the batch. ErrorLevel Exits ~~~~~~~~~~~~~~~~ For ease of use within batch files.. in all cases, SuperK will exit with an ErrorLevel determined by the success of the transfer. If ALL transfers are successful, SuperK will return an ERRORLEVEL 0 If ANY ONE transfer fails, SuperK will return an ERRORLEVEL 1 Command Line @ Parameter Modification Mode ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Starting SuperK with the @ command line parameter will put SuperK into its default modification mode. SuperK will first display its current default settings and then prompt you for any changes you may wish to make. Note that entering a blank line (simply hitting [Enter]) will leave the current setting intact. SuperK allows modification to the colors it uses, the logfile name, the xfer file name (for BBS use), the overlay path and certain operational flags. C - Modifying colors: This one's easy! After selecting the C option, SuperK will display the 127 color palette that it supports. Simply select a number for each of the 7 colors used... SuperK will cycle through all 6 colors, updating the "current settings" accordingly. If you don't want to change a current color setting, simply hit the [Enter] key and SuperK will move on to the next setting. Note: Jmodem window colors default to black text on a white background. The 7 color types are: Xcolors for Xmodem/Xmodem CRC/WXmodem transfers Wcolors for WXmodem transfers Kcolors for K9Xmodem transfers Ycolors for Ymodem transfers Scolors for Super8K transfers Mcolors for Super8K-G transfers Ucolors for universal display of the SuperK logo and batch filenames D - Logfile Name: This is the filename SuperK uses to record the results of any tranfers it performs. SuperK will accept upto 40 characters so you may include a full drive:\path\ along with the logfile name. Additionally, you may use a question mark (?) as one (and only one) of the logfile name characters. If a question mark is present, SuperK will substitute the Node character in its place. If no node character is specified, SuperK will use the letter A as a Node character. The letter A is substituted ONLY if the question mark is encountered in the logfile name. If you do not want SuperK to maintain a logfile, simply enter a backslash (\).. which will inform SuperK to blank out the logfile name. The default logfile name is SK4.LOG E - XferFile Name: This is the filename SuperK uses to record transfer results for use by BBS programs. Its format and modification is identical to the Logfile Name. The default Xferfile name is XFER.TXT F - OvlPath: Although in most cases, you will be storing all of the SuperK files in the same directory as your comm/BBS program files, there are cases where you may want to store them in a directory other than the logged directory. This option allows you to do this. When SuperK starts up, it will use the OvlPath to locate its overlay file (SUPERK.000) and Jmodem module (SKJ.COM). You must supply the full drive and path in which the SKJ.COM, SUPERK.COM and SUPERK.000 files reside and all SuperK files MUST reside in this area. If no OvlPath is defined, SuperK will expect all of its files to reside in the logged directory. If, after defining a path, you decide that it is NOT required, simply enter a backslash \ for the new path. This will cause SuperK to null out any existing path. G - Overwrite: This flag setting tells SuperK whether or not in can overwrite existing files during Batch mode transfers. The default is NO H - Save Aborts: This flag setting tell SuperK whether or not it should keep any partial files which were aborted during transfer. This flag holds for any protocol - batch or single file mode. The default is YES I - Write On 0: This flag setting tells SuperK whether or not it should create the XferFile when a transfer is not successfully completed and the uploaded file contains 0 bytes. The status of this flag is the last check that SuperK makes before creating the XferFile. A node character and XferFile Name must be specified before the Write On 0 flag comes into play. The default is YES W - Work Path This parameter was included in order to supply a simple means of transferring files which have the Read Only attribute set. Since the Turbo Pascal compiler opens all files in a Read and Write state, SuperK would experience an I/O error when attempting to open a Read Only file. Since this problem is more prevelant in a networking environemnt... and I didn't particularly care to have to revamp all of the SuperK file read/write I/O routines... This option will circumvent the compiler problem for those users who wish to use the SuperK driver to send Read Only files. By specifying a work path here, SuperK will create a copy of the requested download in this directory and then proceed to send the copy. Upon completion (or abort) SuperK will erase the copy. Of course, you may use this feature regardless of the File's Read Only Attribute... if you feel insecure at having SuperK access the "master" file, set up a work path and SuperK. If a work path is specified, it MUST be a complete path including a drive letter, colon, backspace, directory etc... upto a maximum of 40 characters. As is the case with the SuperK support files, you may use a question mark as a valid character within the path string. If SuperK encounters a question mark in the Work Path, it will substitute the node character specified on the command line or, if none is specified, SuperK will substitute an A for the question mark. Valid Paths: Specifed Result C:\BBSWORK C:\BBSWORK\filename C:\NODE?WRK if no node specified C:\NODEAWRK\filename if node 1 specified C:\NODE1WRK\filename C:\BBS\NODE? if no node specified C:\BBS\NODEA\filename if node 1 specified C:\BBS\NODE1\filename InValid: C:\NODE?WRK? if no node specified C:\NODEAWRK?\filename if node 1 specified C:\NODE1WRK?\filename [Enter] Quit: If you only wish to view the current default settings, simply hit [Enter] to exit back to DOS. If any changes have been made, SuperK will go into its cloning mode and ask if you want to clone SuperK to preserve the new changes. Note that you MUST press the Y key in order to clone SuperK. Hitting [Enter] here will simply return you to DOS without saving your changes within the SuperK program. Program control keys ~~~~~~~~~~~~~~~~~~~~ SuperK will recognize either the [Esc] key or ^X (control X) key during transfers and will abort the current transfer, returning you to DOS. Note that the streaming protocols (Wxmodem, K9Xmodem) may require several [Esc] or ^X to abort the transfer and Jmodem/JBatch may require a ^Break to abort the transfer. I have modified the Jmodem module (SKJ.COM) to eliminate as much of the delays as possible... making the batch mode cycling quite "brisk"! Note however that there is a delay if the Jmodem transfer is aborted for any reason... this is due to the fact that the buffers have to be "drained" before recycling. Batch transfers ~~~~~~~~~~~~~~~ SuperK is capable of sending and receiving multiple files in batch mode. Since this protocol driver was written for use with my MiniNet BBS package... the sending of the file creation date (ala DSZ and Telink) tends to drive me up the wall, creating quite a bit of confusion in keeeping track of newly acquired files! For this reason the major difference between SuperK Batch mode and other Batch modes is that SuperK Batch only sends the File Name and File size but does not send the file creation date. During Batch mode transfers, SuperK will display the last 3 files requested under the SuperK logo so that you may have a running update of what's happening. The present transfer progress is displayed in its own window alongside the SuperK logo. SuperK is able to handle multiple filenames on the command line. The command syntax remains the same but if more than one filename is specified, SuperK will create its own BATCHLST file. If a Node character is specified on the command line, that character will be used for the extension of BATCHLST. The default is "A" if no node character is specified. The number of filenames that can be specified will depend largely on your own particular system setup, the string length used by your calling program and the individual filename lengths. This feature is only active while in Batch Send Mode (receive automatically gets filename from sender), the command line paramaters can be in any order, NO WILDCARDS ARE ALLOWED, the first filename MUST be preceeded by an F (upper or lower case) and EACH filename may include a full path. Your command line should look like this... SUPERK p1 s9600 SWB f FILE1 FILE2 FILE3 Since the BATCHLST is created internally (by SuperK), SuperK will erase the BATCHLST file once it is done with it... You may override this by including an E as one of the command line parameters. The E parameter toggles the status of the "erase" flag. If specified on the command line, SuperK will not erase the BATCHLST file (until the next time you specify multiple filenames, that is!) Receiving files in Batch mode ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ You do not have to supply any filename during batch mode receives. You may of course, include a full drive:\path\ in place of a filename. Use the F command line parameter to designate the path in the form: f C:\FOO\BAR (with or without the trailing backslash). And... DO NOT specify the f parameter if no path or filename is specified. Sending files in batch mode ~~~~~~~~~~~~~~~~~~~~~~~~~~~ You may use any valid DOS wildcard configuration with the F parameter. Additionally, you may specify a list of filenames for SuperK to send. The list filename is specified as @drive\:path\listfilename You may also specify a full drive:\path\ to where all of the files in the list reside. This is specified as @drive:\path\filelist@drive:\path The filenames in the list may contain a full drive:\path\ (the same or different) for each filename. SuperK is capable of reading and extracting filenames from a standard - single line - BBS files listing. If you use a BBS type files listing, and call SuperK from the comm or BBS directory, you will have to add the full drive:\path\ to each filename in the list if the files to send do not reside in the default directory. There are other ways of accessing files that reside in directories other than the default (default upload and download directories, etc.), but I won't go into this area as most comm and BBS programs do this work for you (K9X does it ALL for you... automatically!) Examples ~~~~~~~~ 1. Use COM1, 1200 baud, Xmodem, Send files MYFILE.DOC and FILE.COM SUPERK p1 s1200 SX f MYFILE.DOC FILE.COM 2. Use COM2, 19200 baud, Ymodem Batch, Receive file *.DOC, do not monitor carrier, override the default "do not overwrite". SUPERK p2 s19200 m RYBY Note: The protocol character must follow the direction R. The second Y above is the override for the overwrite flag. The B and second Y may be in any order just as long as they are the third and fourth characters in the Direction parameter. 3. Use COM1, 9600 baud, K9Xmodem Batch Send files in MYLIST.LST which resides in my C:\BBS\ directory. The files listed in MYLIST.LST reside in various directories on different drives. Do not monitor carrier and record success results to Node A of my BBS. SUPERK p1 s9600 SKB m nA f @C:\BBS\MYLIST.LST C:\BBS\MYLIST.LST looks like this: ABC.PAK (this one resides in the default directory) D:\FOO\BAR\MYGAME.EXE E:\LOTUS\123GRAPH.PAK XFER.TXT (or XFERA.TXT if ? specified in the default xferfile name) will reflect the results of the transfer. Note that only the first filename and its transfer results will be present in XFER.TXT. SUPERK.LOG will however, contain the results of all three files. 4. Use COM2, 19200 baud, K9Xmodem Batch Send only files containing an PAK extension and residing in my C:\DLS directory, and don't monitor carrier. SUPERK p2 s19200 SKB m f C:\DLS\*.PAK 5. Use COM2, 19200 baud, K9Xmodem Batch Receive files - store them in my C:\DLS directory. SUPERK p2 s19200 RKB f C:\DLS Batch Files ~~~~~~~~~~~ There are sample batch files included in SUPERK.PAK SEND.BAT - this batch file is set up for sending file(s) to another system RECV.BAT - this batch file is set up to receive file(s) from another system Executing any one of the batch files without any parameters (or the wrong parameter) will display a short message showing the correct calling procedure and parameter choices. Since these batch files handle transfers in either Send or Receive mode and single or batch mode, you will have to supply the proper information in order to have them perform correctly. NOTE: If you are operating a MiniNet BBS v18.00 or above... or K9X v8.xx or above... access to SuperK is handled internally and does not require the use of the batch files. If you are not... please read the enclosed PRODUCTS.TXT file... It's worth a look! For pure BBS'ing, K9X can't be beat! ------------------------------------------------------------------------------ I have been using this protocol driver on Underdog's MiniNet for quite some time now. If you need more information on the various transfer protocols, please get a copy of K9X (my comm program) and review the K9X.DOC file contained in that package. All suggestions are gratefully received and reviewed! Let me know... Sal Manaro dba Crater Rim Softare 4028 41st Ave South Seattle, Wa 98118 USA (206) 723-6728 voice Underdog's MiniNet (206) 725-9233 1200/2400/9600 24hrs 1.2 Gigabytes of Files Supporting 26 files transfer protocols! Enjoy, Sal Manaro - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - N O T I C E N O T I C E N O T I C E N O T I C E N O T I C E Due to the amount of time and money I have spent setting up SuperK for use with your Comm/BBS programs, I am requiring that this and all subsequent versions of SuperK be registered so that I may be compensated for the many hours I have spent developing, modifying and setting up this protocol driver. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ----------- LET YOUR PRINTER DO ALL THE WORK! INSTANT MAILER!!! --------- Please support quality shareware by registering your copies We thank you for your support! Remit To: Sal Manaro dba Crater Rim Software SuperK Order Form 4028 41st Ave. South Seattle, WA 98118 USA Quantity Discount Schedule (per purchase). Each: 1-10 $25.00 11-49 $23.00 50-99 $20.00 100-199 $18.00 200-499 $15.00 500+ $12.00 Please send the ShareWare Evaluation version 4.xx ------------------------------------------------- ____ SuperK Disk(s) without registration ...... @ $ 10.00 ea. $ _______ I don't mind the Shareware screen and would like to register the copy I already have: ------------------------------------------------ ____ SuperK Registration(s) Only .............. @ $ 20.00 ea. $ _______ Please register and send the latest version: ------------------------------------------- ____ SuperK Registration(s) and Disk .......... @ $ 25.00 or $ _______ PO, Rush and COD orders add $5.00 ........................... $ _______ Subtotal _______ (Washington residents please add 8% sales tax) Tax _______ Total $ _______ Payment by: ( ) Check ( ) Money Order ( ) PO # ___________________ Use address on check ( ) or mail to: Name: ______________________________________________________________ Company: ______________________________________________________________ Address: ______________________________________________________________ : ______________________________________________________________ : ______________________________________________________________ Day Phone: (______)__________________ Eve: (______)______________________ ORDERS OUTSIDE USA: Use Check or Money Order drawn on US bank in US dollars ------------------- INSTANT MAILER ---------------------- Fold at the page break below with the printing above facing up and the mailing label below folded underneath. Staple check to the mailer, fold letter style, exposing the mailing address and hiding your information. Fold sides along dotted line and staple or tape sides and top. |_________________________________ Place | | | |_________________________________ Stamp | | | |_________________________________ Here | | | | | | | | | | | | | | Crater Rim Software | | 4028 41st Ave South | | Seattle WA 98118 USA | | | | | | | | |